home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr38 / vpsb111.zip / VPSB.DOC < prev    next >
Text File  |  1995-04-04  |  13KB  |  272 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                     VGA Planets Score Builder v1.11
  10.                   by Alex Ivlev, The ShareNet Trolls
  11.                               (c) 1995
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25. CONTENTS :
  26. ==========
  27.     I.  Purpose
  28.    II.  Registration
  29.   III.  Disclaimer
  30.    IV.  Usage
  31.     V.  Form Files
  32.    VI.  Trouble Shooting
  33.  
  34.  
  35. PURPOSE
  36. =======
  37.      VPSB is a configurable score display program for VGA Planets.  It was
  38. designed for use by SysOps, however, players can also use this program to
  39. keep track of changes in empires from turn to turn.  Future versions will keep
  40. track of empire changes for the entire game.  VPSB has several variables the
  41. user can configure in whatever color or location they wish.  The original
  42. idea of VPSB was to allow the user to customize how the score is displayed.
  43.   In short VPSB offers :
  44.      - Uses either player files or host files, so both sysops and players
  45.        can use VPSB
  46.      - User defined colors and location of score data
  47.      - Tracks player data and reports + and - in player stats turn to turn
  48.      - 13 basic variables, plus
  49.         - a sum of totals for all of the 6 race variables
  50.         - player's score percentages of the total game totals
  51.    *    - tracking score totals to display difference between the value of
  52.           the previous turn and present turn
  53.      - support for any combination of the above
  54.      - Uses RACE.NM and supports alternative race names
  55.    * - Supports team scores and ranks each TEAM rather than each player
  56.      - Output can be in any type you create (e.g., ANSI, ASCII, AVATAR,
  57.        @-CODES)
  58.  
  59. * Registered Only
  60.  
  61. REGISTRATION
  62. =============
  63.      Registration is $5.00 US dollars. We won't be mailing out any keys, ALL
  64. REGISTRATION KEYS will be available for download on ShareNet BBS.  When you
  65. are ready to register fill out the orderfrm.txt file and mail in your money.
  66. Once we receive it, we will attach your registration key to you in a message
  67. on ShareNet.  The shareware version has all the functions of a registered
  68. version except for tracking player score changes for players at the top of
  69. the score and team scores.  Once registered, you can receive free upgrades to
  70. all future versions of VPSB.
  71.  
  72. DISCLAIMER
  73. ==========
  74.      This won't mess up your computer as far as we know, but if it does we
  75. won't be responsible.  Hey, it creates an ANSI file, how much harm could it
  76. do?
  77.  
  78. USAGE
  79. ======
  80. Command Line:
  81.      VPSB xxxx.FRM [PATH TO GAME] OUTPUT FILE
  82.   e.g., vpsb score.frm d:\bbs\vga\game3 d:\bbs\bull\bull105.bbs
  83.      This will use the form file `score.frm' for creating the output file
  84.      bull105.bbs. This will contain info from game 3.
  85.  
  86.     * This is the simplest use of VPSB.  If you have more than one game
  87.     and want all the scores in one bulletin you can do something similar
  88.     to the little batch file I created called score.bat:
  89.    cd \vpsb
  90.    vpsb score.frm d:\bbs\vga\game3 score3.ans
  91.    vpsb score.frm d:\bbs\vga\game4 score4.ans
  92.    vpsb teamscor.frm d:\bbs\vga\game7 score7.ans
  93.    copy clear + score3.ans + score4.ans + score7.ans \bbs\bull\bull200.bbs
  94.     The file `clear' is just a plain file with a clear screen code so
  95.     when somebody views the bulletin it clears the screen first.   For
  96.     bbs boards, you'd simply have in your clear file:
  97.    @CLS@
  98.      This creates a nice bulletin with all your game scores.
  99.  
  100.      Note:  You may want to customize the score for each game. For example,
  101. you might want to have the game name in each score, like `BORGDOOM' or even
  102. just `GAME 7 of the Hot Heads'.  To do this you need a separate form file for
  103. each game, so you might have a borg.frm and game7.frm.   The command line is
  104. the same as above, just use the game's specific form file.  To create and edit
  105. form files, see below.
  106.  
  107. FORM FILES
  108. ==========
  109.      It isn't necessary to make your own files, both a regular individual game
  110. score form file (score.frm) and a team score form file (teamscor.frm) are
  111. provided.  If you have troubles understanding what's below, referring to how
  112. those two files are set up may help.
  113.      The `form' files are like templates that VPSB uses to map data onto.  By
  114. editing/creating different form files, you can create different ways VPSB will
  115. display your game scores.  When making your form files, or templates if you
  116. prefer, there are several variables at your disposal.
  117.      There are two basic groups of variables.  One set involves formatting and
  118. printing instructions, while the other set contains the actual score
  119. variables.  There are 5 format-related variables, and 8 score-related
  120. variables.
  121. Format Related Variables
  122. ------------------------
  123. ~FORMAT     : Defines the format (e.g., color, spacing) that will be used
  124.               in either the ~PRINT or ~CYCLE lines.  Note that `#' are used
  125.               to define the number of characters to use for a given field.
  126. ~PRINT      : This defines the fields to use in your `#' created above.
  127.               The only statements you will use after this command are score
  128.               related variables.
  129. ~CYCLE n
  130. ~CYCLE TEAM : This defines the number of races to cycle through (print
  131.               data).   ~CYCLE 1 will run through one race.  ~CYCLE 5 will
  132.               run through the first 5 races (if it's the first cycle
  133.               command).  ~CYCLE TEAM will run through the first set of races
  134.               you defined in the ~TEAMS.  The difference between ~PRINT and
  135.               ~CYCLE is that ~CYCLE n relates to n races, where the ~PRINT
  136.               command relates to all races.  Thus, one would use only ~TURN
  137.               or other race-independent variables (see below) with the
  138.               ~PRINT command.
  139. ~TEAMS      : Used to rearrange races in a team game.  Each team is
  140.               defined on this line.  For Example, the line ~TEAMS 123 456
  141.               789 AB would result in 3 teams (Team 1:feds, lizards, birds;
  142.               Team 2: fascists, privs, borg; Team 3: crystals, empire,
  143.               robots; Team 4: rebels, colonies).  When the ~CYCLE TEAM
  144.               option is then used, VPSB will look at the race whose in first
  145.               place and put whatever team that race belongs to on the top of
  146.               the score.  For example, if the borg have the highest score of
  147.               all 11 races, then Team 2 (fascists, privs and borg) will be
  148.               at the top.  Then, say the fascists have the second highest
  149.               score, since they're already listed, the third highest score
  150.               will be looked at and so on until all teams are displayed.
  151.  
  152. Score Related Variables
  153. -----------------------
  154.       ~TURN     : Simply the current turn number
  155.       ~RACE     : Race Name. Watch out how many `#' you define for
  156.                   the race name. ####### will result in Crystal instead of
  157.                   Crystalline.
  158.       ~SCORE    : Race score.  Same as in the game.
  159.       ~PLANETS  : Number of planets owned by race.
  160.       ~BASES    : Number of starbases the race has.
  161.       ~CAPSHIPS : Number of capital (war) ships the race has.
  162.       ~FRSHIPS  : Number of freighters.
  163.       ~ALLSHIPS : Sum of capital ships and freighters.
  164.  
  165.      In addition, there are *, %, and + prefixes you can add to each of the
  166. above score related variables.   The shareware version will only use the +
  167. prefix variable for the last placed half of races.
  168.    Prefix   Function
  169.      *      : Is used to obtain a sum of all races variables.  For
  170.               example, *PLANETS displays the overall number of colonized
  171.               planets in the universe by all races.  *ALLSHIPS displays the
  172.               number of ships built so far in the game.
  173.      %      : Similar to * prefix, but gives the percentage or
  174.               proportion a race has to what all races have.  For example,
  175.               %PLANETS displays the percentage of a race's planets to the
  176.               total planets colonized.  The value will be 33 if the race has
  177.               colonized 1/3 of the total planets (e.g., 20 of 60 total
  178.               planets, 10 of 30 etc..,).
  179.      +      : The shareware version will only recognize this for races in
  180.               the bottom half of the score.  This calculates the difference
  181.               between this turns value and last turns value.  For example,
  182.               +PLANETS shows the number of planets colonized or lost by the
  183.               last turn.  +SHIPS shows the number of ships a race either
  184.               build or lost (or captured) this turn.
  185.      
  186.     Any of these prefixes can be combined with one another if you wish.  For
  187. example, *+ALLSHIPS will display the number of ships built or destroyed by all
  188. 11 races last turn.
  189.  
  190. Some simple examples:
  191. ---------------------
  192.  
  193.      ~FORMAT
  194.      Borgdoom Game.  On Turn : ###
  195.      ~PRINT
  196.      TURN
  197. Will result in (if on turn 37):
  198.      Borgdoom Game.  On Turn :   37
  199. -------------------------------------------------------
  200.  
  201.      |    Race     | Score |    Planets    |
  202.      ~FORMAT
  203.      |************ |  #### | ### (###) ##% |
  204.      ~CYCLE 1
  205.      RACE,SCORE,PLANETS,+PLANETS
  206. Will result in (with whatever are the proper values):
  207.      |    Race     | Score |    Planets     |
  208.      |Cyborg       |  1561 |  37 ( +2) 11%  |
  209. ----------------------------------------------------------
  210. Meaning the Borg are in first place (if this was the first ~CYCLE, have a
  211. score of 1561, own 37 planets, which is 2 more than they owned last turn, and
  212. 37 planets is 11% of the planets owned by any race in the game.
  213.  
  214. This is only one level of VPSB.  All the above are plain colors, all the same.
  215. What makes a bulletin attractive, however, is adding color.  Using any ANSI
  216. (or whatever) creator like THE DRAW, you can color the above info to display
  217. in color.  NOTE!!  The Draw, and perhaps some other such programs sometimes
  218. add color codes where they aren't supposed to be!  There are really only three
  219. restrictions you need to worry about when creating your customized display:
  220.      1.  One line with registration information is added, centered, as the
  221. first line of your output.  Since the maximum lines a screen can be for most
  222. BBSs without getting a `pause' or `more' prompt is 24, you want your form file
  223. to produce 23 lines of output (maximum).  Since one line is added, this gives
  224. you  > 22 lines to print what you want.
  225.      2.  An 80 column wide display can sometimes create line breaks.  The
  226. easiest way around this is to simply make the display 79 characters wide.
  227.      3.  All variables (e.g., ~FORMAT, ~CYCLE, RACE, TURN) must be at the
  228. BEGINNING of the line and must NOT have any color codes before them.  The
  229. easiest way to do this is to put the codes at the beginning, and don't color
  230. those lines.
  231.  
  232. Thus, your form file should conform to printing all of what you want in a page
  233. 22 lines long, 79 characters wide.  In addition, all your variables must start
  234. at the beginning and not have any color codes before them (you can check the
  235. color codes with most ASCII editors and simply remove them if they appear).
  236.  
  237. TROUBLE SHOOTING:
  238. =================
  239.      Here are some things to check if your form file isn't displaying
  240. properly:
  241.  
  242. - Make sure all variables are at the beginning of the line.  You may have to
  243.  look at the form file with an ASCII editor to check.
  244. - If you get ?? in a field or not enough of the info, make sure you have
  245.  enough ####s to properly display the field.  For example, ## will display ??
  246.  for the +CAPSHIPS field if the race has either an increase or decrease of
  247.  more than 9 ships.
  248. - The +VARIABLE only displays info for the bottom scores.  Simple, you haven't
  249.  registered it, or you don't have your VPSB.REG in the same directory as
  250.  VPSB.EXE.
  251. - You don't understand this documentation.  Ahhh...sorry, I'm not a writer,
  252.  but I tried!  You can ask either Alex Ivlev or Red Troll anything that is
  253.  unclear in VGA.PLANETS, a Fido Backboned echo conference.
  254.  
  255. ---------------------------------------------------------------------------
  256.  
  257.            ▄█▀    ▀██     (916) 899-7628        ▀██▄  █▀          ▄
  258.     ô      ▀▀██▄   ██ ▄▄    ▄▄▄   ▄ ▄▄▄    ▄▄▄   ███▄ █    ▄▄▄   ██
  259.    °¥°╪       ▀██  ██▀ ██  ▀▀▄██   ██ ██ ▄██ ██  █ ██▄█  ▄██ ██ ▀██▀
  260.    ┘ └         ██  ██  ██  ▄█ ██   ██    ██▀▀▀▀  █  ███  ██▀▀▀▀  ██
  261.            ▀▄▄█▀  ▄██  ██▄ ▀█▄▀▀▄ ▄██     ▀█▄▄▀ ▄█   ██   ▀█▄▄▀  ▀█▄▀
  262.                              Φ                  Φ
  263.    Sysop: Red Troll          ╫──────────────────╫
  264. CO-Sysop: Black Troll      ╫─╫ ░▒▓█░▒▓█░▒▓█░▒▓█ ╫─╫        Networking your
  265.                        Φ ╫─╫ ░▒▓█░▒▓█░▒▓█░▒▓█░▒▓█ ╫─╫ Φ     Shareware Products
  266.                        ╫─╫ ░▒▓█░▒▓█        ░▒▓█░▒▓█ ╫─╫
  267.                  ô     ╫ ░▒▓█                    ░▒▓█ ╫
  268.                ╪°¥°    ░▒▓█                        ░▒▓█
  269.                 ┘ └                               
  270.                                                   
  271.       BBS 916-899-7628             FIDO 1:119/99          VGAPnet 57:916/0
  272.